GraphObject Object

Sample Code - GraphObject Object

The GraphObject Object represents a graph/chart found in a report. This object provides properties for retrieving information and setting options for a chart in your report (that is, graph data type -- group, detail or graph display type -- bar, pie, etc.).

GraphObject Object Properties

Property Description Read/Write

Application

Returns a reference to the Application Object, this object is associated with.

Read only

ColumnGroup
Number

Returns/Sets the group number that the column of the graph gets its data from (that is, in a stacked bar graph, the "column" is the bar of the graph, so there will be one bar for each group).

Read/Write

ConditionField

Returns/Sets the Detail field to be graphed on. This property applies to only detail graphs; using this property with a cross-tab or group graph will result in an error.

Read/Write

CrossTabObject

Returns CrossTabObject Object, with information regarding the cross-tab object used to graph on. This property applies only to cross-tab graphs; using this property with a detail or group graph will result in an error.

Read only

DataFields

Returns the FieldDefinitions object that represents the data fields of the graph (that is, numeric fields for graph data). Specifies a collection of graph data fields. This property applies only to detail graphs; using this property with a cross-tab or group graph will result in an error.

Read only

DataType

Returns CRGraphDataType (see table below) which specifies the type of data used in the graph.

Read only


Constant Value


crCrossTabGraph

2


crDetailGraph

1


crGroupGraph

0

Property Description Read/Write

Direction

Returns/Sets CRGraphDirection (see table below) indicating if the graph groups on only the rows of a cross-tab, only the columns, or a combination of both (that is, for stacked bar graph). This property applies to only cross-tab graphs.

Read/Write


Constant Value


crGDColumnsOnly

1


crGDMixedColumnRow

3


crGDMixedRowColumn

2


crGDRowsOnly

0


crGDUnknownDirection

20

Property Description Read/Write

DisplayType

Returns/Sets CRGraphDisplayType (see table below) indicating which graph representation type used for the graph (that is, SideBySideGraph, PieGraph, etc.).

Read/Write


Constant Value


crAreaGraph

120


crFaked3DPercentBarGraph

6


crFaked3DSideBySideBarGraph

4


crFaked3DStackedBarGraph

5


crLineGraph

80


crMultiPieGraph

42


crPercentBarGraph

3


crPieGraph

40


crProportionalMultiPieGraph

43


crSideBySideGraph

0


crStackedBarGraph

2


crThreedBarGraph

160


crUnkownTypeGraph

1000


crUserDefinedGraph

500

Property Description Read/Write

FontFaceName

Returns/Sets the font for the title, subtitle, and footnote text included with the graph. Fonts available for any report are dependent upon the printer driver selected for the report.

Read/Write

FootNote

Returns/Sets the footnote text that appears at the bottom of the graph.

Read/Write

GroupsTitle

Returns/Sets the title of the groups that are being graphed.

Read/Write

Kind

Returns CRObjectKind object (see table below), which specifies what "kind" of object (that is, box, cross-tab, field, etc.).

Read only


Constant Value


crBlobFieldObject

9


crBoxObject

4


crCrossTabObject

8


crFieldObject

1


crGraphObject

7


crLineObject

3


crOleObject

6


crSubreportObject

5


crTextObject

2

Property Description Read/Write

MaxValue

Returns/Sets the maximum value that will appear in the graph. Any graph values above this value are not graphed.

Read/Write

MinValue

Returns/Sets the minimum value that will appear in the graph. Any graph values below this value are not graphed.

Read/Write

Parent

Reference to the Parent object (Section Object).

Read only

Report

Reference to Report Object.

Read only

RowGroup
Number

Returns/Sets the group number of the group that supplies the data for the graphs rows. For example, in a stacked bar graph, the row would be the stacked data. For graphs with no rows, this value is -1. (This property does not apply to a detail graph.)

Read/Write

SeriesTitle

Returns/Sets the title of the series which is being graphed.

Read/Write

ShowDataValue
Enabled

Returns/Sets Boolean value indicating whether or not to display the numeric value associated with each riser on the graph. If set to TRUE (1), a value appears in the graph for each riser.

Read/Write

ShowGridLine
Enabled

Returns/Sets Boolean value indicating whether or not to display grid lines on the graph.

Read/Write

ShowLegend
Enabled

Returns/Sets Boolean value indicating whether or not to display the graph legend.

Read/Write

ShowVerticalBar
Enabled

Returns/Sets Boolean value indicating whether to display the bars in a bar graph vertically or horizontally.

Read/Write

SubTitle

Returns/Sets the subtitle text that will appear directly under the main title.

Read/Write

SummarizedField

Returns/Sets SummaryFieldDefinition Object, used to supply the data for a group graph. (This property does not apply to a detail graph.)

Read/Write

Title

Returns/Sets the main title text that will appear above the graph.

Read/Write

XAxisTitle

Returns/Sets the text that will appear for the X axis. Not valid for Pie graphs.

Read/Write

YAxisTitle

Returns/Sets the text that will appear for the Y axis. Not valid for Pie graphs.

Read/Write

ZAxisTitle

Returns/Sets the text that will appear for the Z axis. This value is only valid for 3D graphs.

Read/Write



Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com